package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.SalaryFormulaConditionAddDTO;
import org.jsola.hr.dto.SalaryFormulaConditionBatchDTO;
import org.jsola.hr.dto.SalaryFormulaConditionUpdateDTO;
import org.jsola.hr.query.SalaryFormulaConditionQuery;
import org.jsola.hr.vo.SalaryFormulaConditionListVO;
import org.jsola.hr.vo.SalaryFormulaConditionVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-工资方案公式条件")
public interface ISalaryFormulaConditionControllerAPI {

    /**
     * 新增工资方案公式条件
     * @param salaryFormulaConditionAddDTO 工资方案公式条件新增实体
     * @return 工资方案公式条件展示对象
     */
    @ApiOperation(value = "新增工资方案公式条件")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryFormulaConditionAddDTO", dataType = "SalaryFormulaConditionAddDTO", value = "新增工资方案公式条件", paramType = "body")
    })
    Result<SalaryFormulaConditionVO> save(SalaryFormulaConditionAddDTO salaryFormulaConditionAddDTO);


    /**
     * 修改工资方案公式条件
     * @param salaryFormulaConditionUpdateDTO 工资方案公式条件
     * @return 更新数量
     */
    @ApiOperation(value = "修改工资方案公式条件")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryFormulaConditionUpdateDTO", dataType = "SalaryFormulaConditionUpdateDTO", value = "修改工资方案公式条件", paramType = "body")
    })
    Result<Integer> update(SalaryFormulaConditionUpdateDTO salaryFormulaConditionUpdateDTO);

    /**
     * 批量编辑、新增、删除工资方案公式条件
     * @param salaryFormulaConditionBatchDTO 要操作的工资方案公式条件
     * @return 操作之后的全部工资方案公式条件
     */
    @ApiOperation(value = "批量编辑、新增、删除工资方案公式条件")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryFormulaConditionBatchDTO", dataType = "SalaryFormulaConditionBatchDTO", value = "要操作的字段数据", paramType = "body")
    })
    Result batch(SalaryFormulaConditionBatchDTO salaryFormulaConditionBatchDTO);



    /**
     * 删除单个工资方案公式条件，彻底删除
     * @param salaryFormulaConditionId 工资方案公式条件id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个工资方案公式条件，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryFormulaConditionId", dataType = "String", value = "工资方案公式条件id", paramType = "path")
    })
    Result<Integer> delete(String salaryFormulaConditionId);


    /**
     * 批量删除工资方案公式条件，彻底删除
     * @param salaryFormulaConditionIds 工资方案公式条件id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除工资方案公式条件，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryFormulaConditionIds", dataType = "String[]", value = "工资方案公式条件id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] salaryFormulaConditionIds);


    /**
     * 根据工资方案公式条件id查询工资方案公式条件详情
     * @param salaryFormulaConditionId 工资方案公式条件id
     * @return 工资方案公式条件详情
     */
    @ApiOperation(value="根据工资方案公式条件id查询工资方案公式条件详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryFormulaConditionId", dataType = "String", value = "工资方案公式条件id", paramType = "path")
    })
    Result<SalaryFormulaConditionVO> findById(String salaryFormulaConditionId);


    /**
     * 查询工资方案公式条件
     * @param salaryFormulaConditionQuery 工资方案公式条件查询参数
     * @return page
     */
    @ApiOperation(value="查询工资方案公式条件")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryFormulaConditionQuery", dataType = "SalaryFormulaConditionQuery", value = "工资方案公式条件查询参数", paramType = "query")
    })
    Result<List<SalaryFormulaConditionListVO>> listAll(SalaryFormulaConditionQuery salaryFormulaConditionQuery);


     /**
     * 分页查询工资方案公式条件
     * @param salaryFormulaConditionQuery 工资方案公式条件查询参数
     * @return page
     */
    @ApiOperation(value="分页查询工资方案公式条件")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryFormulaConditionQuery", dataType = "SalaryFormulaConditionQuery", value = "工资方案公式条件查询参数", paramType = "query")
    })
    Result<Page<SalaryFormulaConditionListVO>> page(SalaryFormulaConditionQuery salaryFormulaConditionQuery);


}

